home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 5 / Apprentice-Release5.iso / Source Code / Think Class Libraries / TP TCL->CW TCL v1.1.2.3 / UPI ƒ / Updated UPIs ƒ / ErrMgr.p < prev    next >
Text File  |  1996-02-07  |  4KB  |  97 lines
  1. {
  2.     File:        ErrMgr.p
  3.  
  4.     Copyright:    © 1983-1993 by Apple Computer, Inc.
  5.                 All rights reserved.
  6.  
  7.     Version:    System 7.1 for ETO #11
  8.     Created:    Tuesday, March 30, 1993 18:00
  9.  
  10. }
  11.  
  12. {$IFC UNDEFINED UsingIncludes}
  13. {$SETC UsingIncludes := 0}
  14. {$ENDC}
  15.  
  16. {$IFC NOT UsingIncludes}
  17.     UNIT ErrMgr;
  18.     INTERFACE
  19. {$ENDC}
  20.  
  21. {$IFC UNDEFINED UsingErrMgr}
  22. {$SETC UsingErrMgr := 1}
  23.  
  24. {$I+}
  25. {$SETC ErrMgrIncludes := UsingIncludes}
  26. {$SETC UsingIncludes := 1}
  27. {$IFC UNDEFINED UsingTypes}
  28. {$I $$Shell(PInterfaces)Types.p}
  29. {$ENDC}
  30. {$SETC UsingIncludes := ErrMgrIncludes}
  31.  
  32.  
  33. PROCEDURE InitErrMgr(toolErrFilename: Str255;sysErrFilename: Str255;showToolErrNbrs: BOOLEAN);
  34. { ErrMgr initialization.This must be done before using any other ErrMgr
  35. routine.  Set showToolErrNbrs to true if you want all tool messages to contain
  36. the error number following the message text enclosed in parentheses (e.g.,
  37. "<msg txt> ([OS] Error <n>)"; system error messages always contain the error
  38. number).  The toolErrFileName parameter is used to specify the name of a
  39. tool-specific error file, and should be the NULL or a null string if not used
  40. (or if the tool's data fork is to be used as the error file, see
  41. GetToolErrText for futher details). The sysErrFileName parameter is used to
  42. specify the name of a system error file, and should normally be the NULL or a
  43. null string, which causes the ErrMgr to look in the MPW Shell directory for
  44. "SysErrs.Err" (see GetSysErrText). }
  45.  
  46. PROCEDURE CloseErrMgr; C; EXTERNAL;
  47. { Ideally a CloseErrMgr should be done at the end of execution to make sure all
  48. files opened by the ErrMgr are closed.    You can let normal program termination
  49. do the closing.  But if you are a purist...
  50.  }
  51.  
  52. PROCEDURE GetSysErrText(msgNbr: INTEGER;errMsg: StringPtr);
  53. (* Get the error message text corresponding to system error number errNbr from
  54. the system error message file (whose name was specified in the InitErrMgr
  55. call).    The text of the message is returned in errMsg and the function returns
  56. a pointer to errMsg.  The maximum length of the message is limited to 254
  57. characters.
  58.  
  59. Note, if a system message filename was not specified to InitErrMgr, then the
  60. ErrMgr assumes the message file contained in the file "SysErrs.Err".  This
  61. file is first accessed as "                                 {ShellDirectory}SysErrs.Err" on the assumption that
  62. SysErrs.Err is kept in the same directory as the MPW Shell.  If the file
  63. cannot be opened, then an open is attempted on "SysErrs.Err" in the System
  64. Folder. *)
  65.  
  66. PROCEDURE AddErrInsert(insert: Str255;msgString: StringPtr); C; EXTERNAL;
  67. { Add another insert to an error message string.This call is used when more
  68. than one insert is to be added to a message (because it contains more than
  69. one '^' character).
  70.  }
  71.  
  72. PROCEDURE GetToolErrText(msgNbr: INTEGER;errInsert: Str255;errMsg: StringPtr);
  73. (* Get the error message text corresponding to tool error number errNbr from
  74. the tool error message file (whose name was specified in the InitErrMgr
  75. call).    The text of the message is returned in errMsg and the function returns
  76. a pointer to errMsg.  The maximum length of the message is limited to 254
  77. characters.  If the message is to have an insert, then ErrInsert should be a
  78. pointer to it.    Otherwise it should be either be a null string or a NULL
  79. pointer.
  80.  
  81. Inserts are indicated in error messages by specifying a '^' to indicate where
  82. the insert is to be placed.
  83.  
  84. Note, if a tool message filename was not specified to InitErrMgr, then the
  85. ErrMgr assumes the message file contained in the data fork of the tool calling
  86. the ErrMgr.  This name is contained in the Shell variable    {Command} and the
  87. value of that variable is used to open the error message file. *)
  88.  
  89.  
  90.  
  91. {$ENDC}    { UsingErrMgr }
  92.  
  93. {$IFC NOT UsingIncludes}
  94.     END.
  95. {$ENDC}
  96.  
  97.